// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using System.Collections.Generic;

namespace Taimila.Entify
{
	/// <summary>
	/// Value set filter can be used to check that property's value is in the given set of values.
	/// </summary>
	public sealed class ValueSetFilter : IDataFilter
	{
		/// <summary>
		/// Create a new ValueSetFilter with include rule.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property to be fitered. <see cref="System.String"/>
		/// </param>
		/// <param name="values">
		/// List of accepted values. <see cref="System.Object[]"/>
		/// </param>
		public ValueSetFilter (string targetProperty, params object[] values)
		{
			this.TargetProperty = targetProperty;
			this.Values = new List<object>();
			this.Values.AddRange(values);
			this.Rule = ValueSetRule.Include;
		}
		
		/// <summary>
		/// Create a new ValueSetFilter with include rule.
		/// </summary>
		/// <param name="targetProperty">
		/// Name of the property to be fitered. <see cref="System.String"/>
		/// </param>
		/// <param name="values">
		/// List of accepted values. <see cref="System.Object[]"/>
		/// </param>
		/// <param name="rule">
		/// Should filtered property's value be in the given value set or not. <see cref="ValueSetRule"/>
		/// </param>
		public ValueSetFilter (string targetProperty, ValueSetRule rule, params object[] values) : this(targetProperty, values)
		{
			this.Rule = rule;
		}
		
		/// <summary>
		/// Name of the property. Filter this property.
		/// </summary>
		public string TargetProperty
		{
			get;
			set;
		}
		
		/// <summary>
		/// List of accepted values.
		/// </summary>
		public List<object> Values
		{
			get;
			set;
		}
		
		public ValueSetRule Rule
		{
			get;
			set;
		}
	}
	
	/// <summary>
	/// Enumarates value set rules.
	/// </summary>
	public enum ValueSetRule
	{
		Include,
		Exlcude
	}
}
